DescribeBlockSwitchs
Description
query the current blocking switch list status information in DDoS settings.
Request Method
POST
Request Path
/apsara/route/Ddosprivate/DescribeBlockSwitchs
Request Parameters Common Parameters
Name | Location | Type | Required | Sample value | Description |
---|---|---|---|---|---|
PageSize | BODY | integer | No | No sample value for this parameter. | specifies the maximum number of records displayed on the page. |
CurrentPage | BODY | integer | No | No sample value for this parameter. | specifies the current page number returned. |
regionId | BODY | string | Yes | No sample value for this parameter. | region id |
version | BODY | string | No | 2016-01-01 | version of api |
Return data
Name | Type | Sample value | Description |
---|---|---|---|
TotalCount | integer | no demo value | returns the total number of pages. |
Description | string | no demo value | brief description of the blocking switch. |
RequestId | string | no demo value | request ID. |
PageSize | integer | no demo value | page displays the maximum number of records. |
CurrentPage | integer | no demo value | currently returns page number. |
Mode | integer | no demo value | The state of the blocking switch, including: 0: indicates closed state 1: indicates open state |
ModeName | string | no demo value | The status name of the blocking switch, including: closed turned on |
BlockSwitchs | array | no demo value | Blocking switch list information. For specific sub-item descriptions, see the following parameter descriptions. |
Id | integer | no demo value | block switch ID. |
Code | string | no demo value | block switch code, used to identify the uniqueness of this parameter. |
Name | string | no demo value | the name of the blocking switch. |
Example
Successful Response example
{
"TotalCount":"no demo value",
"Description":"no demo value",
"RequestId":"no demo value",
"PageSize":"no demo value",
"CurrentPage":"no demo value",
"Mode":"no demo value",
"ModeName":"no demo value",
"BlockSwitchs":"no demo value",
"Id":"no demo value",
"Code":"no demo value",
"Name":"no demo value"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}